Interface PPPoeClient

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
PPPoeClientImpl

public interface PPPoeClient extends Process
Information provided by the PKI file:

    \class PppoeClient
    
    \brief PppoeClient handles and manipulates the PPPoE client.
    
    \example network().getDevice("PC0").getProcess("PppoeClient")
    
Author:
Auto-generated
  • Method Details

    • setUsername

      void setUsername(String userName)
      Information provided by the PKI file:
      
          \brief Sets the username.
          
          \param userName, the username.
          
              
      Parameters:
      userName - Takes in a parameter of userName
    • setConnectionStatus

      void setConnectionStatus(PPPoeConnectionStatus status)
      Information provided by the PKI file:
      
          \brief Sets the status.
          
          \param status,      the status types: eConnected = 0,
          eConnecting = 1,
          ePoolRejected = 2,
          eDisconnected = 3,
          eTimeout = 4,
          eNoKeepAlive = 5,
          eAuthentcationFailed = 6
          
              
      Parameters:
      status - Takes in a parameter of status
    • getUsername

      String getUsername()
      Information provided by the PKI file:
      
          \brief Gets the username.
          
          \return string, the username.
          
              
      Returns:
      String Returns a String
    • setPassword

      void setPassword(String password)
      Information provided by the PKI file:
      
          \brief Sets the password.
          
          \param password, the password.
          
              
      Parameters:
      password - Takes in a parameter of password
    • getPassword

      String getPassword()
      Information provided by the PKI file:
      
          \brief Gets the password.
          
          \return, the password.
          
              
      Returns:
      String Returns a String
    • setServiceName

      void setServiceName(String service)
      Information provided by the PKI file:
      
          \brief Sets the service name.
          
          \param service, the service name to use.
          
              
      Parameters:
      service - Takes in a parameter of service
    • getServiceName

      String getServiceName()
      Information provided by the PKI file:
      
          \brief Gets the service name.
          
          \return string, the service name to use.
          
              
      Returns:
      String Returns a String
    • connect

      void connect(String userName, String password)
      Information provided by the PKI file:
      
          \brief Makes a PPPoE connection with the specified username and password.
          
          \param userName, the username.
          \param password, the password.
          
              
      Parameters:
      userName - Takes in a parameter of userName
      password - Takes in a parameter of password
    • connectFromPc

      void connectFromPc(String userName, String password)
      Parameters:
      userName - Takes in a parameter of userName
      password - Takes in a parameter of password
    • disconnectFromPc

      void disconnectFromPc()
    • disconnect

      void disconnect(int sessionId, PPPoeConnectionStatus status, boolean sendTerminalFlag)
      Information provided by the PKI file:
      
          \brief Disconnects the PPPoE connection.
          enum EPppoeConnectionStatus
          {
          eConnected = 0,
          eConnecting = 1,
          ePoolRejected = 2,
          eDisconnected = 3,
          eTimeout = 4,
          eNoKeepAlive = 5,
          eAuthentcationFailed = 6
          };
          
              
      Parameters:
      sessionId - Takes in a parameter of sessionId
      status - Takes in a parameter of status
      sendTerminalFlag - Takes in a parameter of sendTerminalFlag
    • isConnected

      boolean isConnected()
      Information provided by the PKI file:
      
          \brief Checks if it is connected.
          
          \return bool, true if connected, false if not.
          
              
      Returns:
      boolean Returns a boolean
    • setConnected

      void setConnected(boolean flag)
      Information provided by the PKI file:
      
          \brief Set if it is connected.
          
          \param flag, true if connected, false if not.
          
              
      Parameters:
      flag - Takes in a parameter of flag
    • getConnectionStatus

      PPPoeConnectionStatus getConnectionStatus()
      Information provided by the PKI file:
      
          \brief Gets the connection status.
          
          \return PppoeConnectionStatus types: eConnected = 0,
          eConnecting = 1,
          ePoolRejected = 2,
          eDisconnected = 3,
          eTimeout = 4,
          eNoKeepAlive = 5,
          eAuthentcationFailed = 6
          
              
      Returns:
      PPPoeConnectionStatus Returns a PPPoeConnectionStatus